JBoss Community Archive (Read Only)

GateIn Portal 3.8

Manage Site Redirections

Site Redirection

GateIn includes a mechanism to redirect user to a different site within the portal based on the characteristics of their browser. This is especially useful for redirecting users to a mobile optimized site when detected they are accessing the portal from a mobile device.

Redirections can be based on various criteria, specified as conditions:

  • The user agent string of the browser accessing the site

  • any properties which can be determined via javascript. This can include things like screen size, pixel density and if the device supports touch or not.

Mapping nodes between original and redirect site when performing the redirect is also available, allowing greater control over what page within the site a user will end up on when a redirect is performed.

The following sections will briefly explain how to configure and setup the site redirection service using the administration user interface.

For details on how to configure site redirects using xml configuration files, please see the Developer Guide: Site Redirection

Manage Site Redirections

Administrator Credentials Required

Creating, editing and deleting a portal redirect requires access credentials that only an administrator may set up.

  1. Navigate to the “Site Redirects and Import/Export” portlet under “Group” > “Administration” in the toolbar.

    images/author/download/attachments/78709415/SiteRedirectsAndImportExportMenu.png

     

  2. On the side menu, select the site for which a new Site Redirect rule is to be created.

    images/author/download/attachments/78709415/SitesListing.png

     

  3. Existing Site Redirects listing will be shown, along with the “Add Redirect” button. Click the “Add Redirect Button” to add a new one or click the “Configure” (wrench icon) to configure an existing one.

    images/author/download/attachments/78709415/SiteRedirectsListing.png

     

  4. Once a Redirect is created, a name must be given and selected the site where it will redirect to, based on the conditions to be configured. There’s also a toggle indicating wether the redirect is currently enabled (“ON”) or disabled (“OFF”). By default it will be disabled on creation.

    images/author/download/attachments/78709415/SiteRedirectName.png

     

  5. The next step is to define the conditions which will trigger the redirect, clicking on the “Add Condition” under the “Conditions” section.

    images/author/download/attachments/78709415/SiteRedirectConsitionsSection.png

     

  6. In the conditions modal, a name must be given to the Condition (a default name is created).

    images/author/download/attachments/78709415/SiteRedirectAddCondition.png

     

  7. In the “User Agent String” section valid Java regular expressions should be used in the “Contains” and “Does not contain” entries, which will be evaluated against the browser User Agent string.
    New conditions can be added (which will be OR’ed with existing ones) by clicking the “Add” button (plus sign icon) and existing ones may be removed by clicking the “Delete” button (trash icon).
     

  8. Pre-defined properties can be added to assist on condition matching, by clicking the “Add Properties” button. Different operators are available for defining these properties.

    images/author/download/attachments/78709415/SiteRedirectConditionProperty.png

     

  9. Once all is set, click the “Save Changes” button to create (or update, in case of editing an existing one) the condition or “Cancel” button to revert it’s creation (or the changes, in case of editing).
     

  10. Conditions can be sorted (for performance reasons, having the less expensive ones on top, for instance) by dragging the condition row and dropping in the desired position.

    images/author/download/attachments/78709415/SiteRedirectConditionsSorting.png

     

  11. The last section of creating a Redirect is to configure Node Mappings, which will map landing site nodes to redirected site nodes. By default this functionality is enabled, it can be toggled by using the “Use node name matching” checkbox.

    images/author/download/attachments/78709415/SiteRedirectNodeMappingsSection.png

     

  12. Click on “Add Mapping” button to add a new node mapping. Existing Node Mappings can be deleted by clicking the “Delete Node Mapping” button (trash icon).

    images/author/download/attachments/78709415/SiteRedirectNewNodeMapping.png

     

  13. Nodes can be selected by clicking the “View Node List” button (list icon) both for the Origin and for the Redirect sites.

    images/author/download/attachments/78709415/SiteRedirectNodeSelection.png

     

  14. Finally, it’s possible to select a default action for unresolved nodes, by selecting from the drop-down menu.

    images/author/download/attachments/78709415/SiteReditectUnresolvedNodesOpen.png

     

  15. With all the conditions and node mappings in place, click the “Save Changes” button in order to create (or update) the Site Redirect or “Cancel” button to cancel all the changes.
     

  16. Redirects can be sorted (for fine-graining purposes, such as having a mobile and a touch site redirect, for instance) by dragging and dropping in the desired positon.

    images/author/download/attachments/78709415/SiteRedirectsSorting.png

     

  17. Redirects can be deleted by clicking the “Delete Redirect” button (icon trash) and confirming or cancelling in the confirmation modal, as desired.

    images/author/download/attachments/78709415/SiteRedirectDelete.png

     

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-10 13:27:11 UTC, last content change 2013-05-23 02:16:25 UTC.